/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using System;
using Composite.C1Console.Actions;


namespace Composite.C1Console.Tasks
{
    /// <summary>    
    /// </summary>
    /// <exclude />
    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 
    public class TaskManagerEvent
    {
    }



    /// <summary>    
    /// </summary>
    /// <exclude />
    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 
    public class FlowTaskManagerEvent : TaskManagerEvent
    {
        /// <exclude />
        public FlowTaskManagerEvent(FlowToken flowToken)
        {
            this.FlowToken = flowToken;
        }


        /// <exclude />
        public FlowToken FlowToken { get; private set; }
    }



    /// <summary>    
    /// </summary>
    /// <exclude />
    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 
	public interface ITaskManager
	{

        /// <summary>
        /// This is called when the tast is created for the first time.
        /// If this method returns false, the task will not get started and
        /// no more events on the task mananger will get called.
        /// </summary>
        /// <param name="taskId"></param>
        /// <param name="taskManagerEvent"></param>
        /// <returns></returns>
        bool OnCreated(string taskId, TaskManagerEvent taskManagerEvent);



        /// <summary>
        /// This is called just before an action/flow is started
        /// </summary>
        /// <param name="taskId"></param>
        /// <param name="taskManagerEvent"></param>
        void OnRun(string taskId, TaskManagerEvent taskManagerEvent);


        /// <summary>
        /// This this will always be called after OnRun and before OnIdle.
        /// It may not be called, and it might also be called more than once.
        /// Check the <paramref name="taskManagerEvent"/> for more information on the call
        /// </summary>
        /// <param name="taskId"></param>
        /// <param name="taskManagerEvent"></param>
        void OnStatus(string taskId, TaskManagerEvent taskManagerEvent);


        /// <summary>
        /// This is called after an action/flow has gone idle
        /// </summary>
        /// <param name="taskId"></param>
        /// <param name="taskManagerEvent"></param>
        void OnIdle(string taskId, TaskManagerEvent taskManagerEvent);


        /// <summary>
        /// This is called when the task is compleated.
        /// </summary>
        void OnCompleted(string taskId, TaskManagerEvent taskManagerEvent);
	}
}
